
<!DOCTYPE HTML>
<html lang="" >
    <head>
        <meta charset="UTF-8">
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <title>（八）注释规约 · GitBook</title>
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
        <meta name="description" content="">
        <meta name="generator" content="GitBook 3.2.3">
        
        
        
    
    <link rel="stylesheet" href="../gitbook/style.css">

    
            
                
                <link rel="stylesheet" href="../gitbook/gitbook-plugin-prism/prism.css">
                
            
                
                <link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
                
            
                
                <link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
                
            
        

    

    
        
        <link rel="stylesheet" href="../styles/website.css">
        
    

        
    
    
    <meta name="HandheldFriendly" content="true"/>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black">
    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
    <link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">

    
    
    <link rel="prev" href="控制语句.html" />
    

    </head>
    <body>
        
<div class="book">
    <div class="book-summary">
        
            
<div id="book-search-input" role="search">
    <input type="text" placeholder="Type to search" />
</div>

            
                <nav role="navigation">
                


<ul class="summary">
    
    

    

    
        
        
    
        <li class="chapter " data-level="1.1" data-path="../">
            
                <a href="../">
            
                    
                    前言
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.2" >
            
                <span>
            
                    
                    一、编程规约
            
                </span>
            

            
            <ul class="articles">
                
    
        <li class="chapter " data-level="1.2.1" data-path="命名风格.html">
            
                <a href="命名风格.html">
            
                    
                    （一）命名风格
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.2.2" data-path="常量定义.html">
            
                <a href="常量定义.html">
            
                    
                    （二）常量定义
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.2.3" data-path="代码格式.html">
            
                <a href="代码格式.html">
            
                    
                    （三）代码格式
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.2.4" data-path="OOP规范.html">
            
                <a href="OOP规范.html">
            
                    
                    （四）OOP规范
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.2.5" data-path="集合处理.html">
            
                <a href="集合处理.html">
            
                    
                    （五）集合处理
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.2.6" data-path="并发处理.html">
            
                <a href="并发处理.html">
            
                    
                    （六）并发处理
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.2.7" data-path="控制语句.html">
            
                <a href="控制语句.html">
            
                    
                    （七）控制语句
            
                </a>
            

            
        </li>
    
        <li class="chapter active" data-level="1.2.8" data-path="注释规约.html">
            
                <a href="注释规约.html">
            
                    
                    （八）注释规约
            
                </a>
            

            
        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.3" >
            
                <span>
            
                    
                    二、异常日志
            
                </span>
            

            
            <ul class="articles">
                
    
        <li class="chapter " data-level="1.3.1" data-path="../异常日志/异常处理.html">
            
                <a href="../异常日志/异常处理.html">
            
                    
                    （一）异常处理
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.3.2" data-path="../异常日志/日志规约.html">
            
                <a href="../异常日志/日志规约.html">
            
                    
                    （二）日志规范
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.3.3" data-path="../异常日志/其他.html">
            
                <a href="../异常日志/其他.html">
            
                    
                    （三）其他
            
                </a>
            

            
        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.4" data-path="../单元测试.html">
            
                <a href="../单元测试.html">
            
                    
                    三、单元测试
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.5" data-path="../安全规约.html">
            
                <a href="../安全规约.html">
            
                    
                    四、安全规约
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.6" >
            
                <span>
            
                    
                    五、MySQL数据库
            
                </span>
            

            
            <ul class="articles">
                
    
        <li class="chapter " data-level="1.6.1" data-path="../MySQL数据库/建表规约.html">
            
                <a href="../MySQL数据库/建表规约.html">
            
                    
                    （一）建表规约
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.6.2" data-path="../MySQL数据库/索引规约.html">
            
                <a href="../MySQL数据库/索引规约.html">
            
                    
                    （二）索引规约
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.6.3" data-path="../MySQL数据库/SQL语句.html">
            
                <a href="../MySQL数据库/SQL语句.html">
            
                    
                    （三）SQL语句
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.6.4" data-path="../MySQL数据库/ORM映射.html">
            
                <a href="../MySQL数据库/ORM映射.html">
            
                    
                    （四）ORM映射
            
                </a>
            

            
        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.7" >
            
                <span>
            
                    
                    六、工程结构
            
                </span>
            

            
            <ul class="articles">
                
    
        <li class="chapter " data-level="1.7.1" data-path="../工程结构/应用分层.html">
            
                <a href="../工程结构/应用分层.html">
            
                    
                    （一）应用分层
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.7.2" data-path="../工程结构/二方库依赖.html">
            
                <a href="../工程结构/二方库依赖.html">
            
                    
                    （二）二方库依赖
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.7.3" data-path="../工程结构/服务器.html">
            
                <a href="../工程结构/服务器.html">
            
                    
                    （三）服务器
            
                </a>
            

            
        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="1.8" data-path="../版本历史.html">
            
                <a href="../版本历史.html">
            
                    
                    附1：版本历史 
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="1.9" data-path="../本手册专有名词.html">
            
                <a href="../本手册专有名词.html">
            
                    
                    附2：本手册专有名词 
            
                </a>
            

            
        </li>
    

    

    <li class="divider"></li>

    <li>
        <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
            Published with GitBook
        </a>
    </li>
</ul>


                </nav>
            
        
    </div>

    <div class="book-body">
        
            <div class="body-inner">
                
                    

<div class="book-header" role="navigation">
    

    <!-- Title -->
    <h1>
        <i class="fa fa-circle-o-notch fa-spin"></i>
        <a href=".." >（八）注释规约</a>
    </h1>
</div>




                    <div class="page-wrapper" tabindex="-1" role="main">
                        <div class="page-inner">
                            
<div id="book-search-results">
    <div class="search-noresults">
    
                                <section class="normal markdown-section">
                                
                                <h2 id="&#x516B;-&#x6CE8;&#x91CA;&#x89C4;&#x7EA6;">(&#x516B;) &#x6CE8;&#x91CA;&#x89C4;&#x7EA6;</h2>
<ol>
<li>&#x3010;&#x5F3A;&#x5236;&#x3011;&#x7C7B;&#x3001;&#x7C7B;&#x5C5E;&#x6027;&#x3001;&#x7C7B;&#x65B9;&#x6CD5;&#x7684;&#x6CE8;&#x91CA;&#x5FC5;&#x987B;&#x4F7F;&#x7528;Javadoc&#x89C4;&#x8303;&#xFF0C;&#x4F7F;&#x7528;/<em>*&#x5185;&#x5BB9;</em>/&#x683C;&#x5F0F;&#xFF0C;&#x4E0D;&#x5F97;&#x4F7F;&#x7528;// xxx&#x65B9;&#x5F0F;&#x3002; 
<br><span style="color:orange">&#x8BF4;&#x660E;</span>&#xFF1A;&#x5728;IDE&#x7F16;&#x8F91;&#x7A97;&#x53E3;&#x4E2D;&#xFF0C;Javadoc&#x65B9;&#x5F0F;&#x4F1A;&#x63D0;&#x793A;&#x76F8;&#x5173;&#x6CE8;&#x91CA;&#xFF0C;&#x751F;&#x6210;Javadoc&#x53EF;&#x4EE5;&#x6B63;&#x786E;&#x8F93;&#x51FA;&#x76F8;&#x5E94;&#x6CE8;&#x91CA;&#xFF1B;&#x5728;IDE&#x4E2D;&#xFF0C;&#x5DE5;&#x7A0B;&#x8C03;&#x7528;&#x65B9;&#x6CD5;&#x65F6;&#xFF0C;&#x4E0D;&#x8FDB;&#x5165;&#x65B9;&#x6CD5;&#x5373;&#x53EF;&#x60AC;&#x6D6E;&#x63D0;&#x793A;&#x65B9;&#x6CD5;&#x3001;&#x53C2;&#x6570;&#x3001;&#x8FD4;&#x56DE;&#x503C;&#x7684;&#x610F;&#x4E49;&#xFF0C;&#x63D0;&#x9AD8;&#x9605;&#x8BFB;&#x6548;&#x7387;&#x3002; </li>
<li>&#x3010;&#x5F3A;&#x5236;&#x3011;&#x6240;&#x6709;&#x7684;&#x62BD;&#x8C61;&#x65B9;&#x6CD5;&#xFF08;&#x5305;&#x62EC;&#x63A5;&#x53E3;&#x4E2D;&#x7684;&#x65B9;&#x6CD5;&#xFF09;&#x5FC5;&#x987B;&#x8981;&#x7528;Javadoc&#x6CE8;&#x91CA;&#x3001;&#x9664;&#x4E86;&#x8FD4;&#x56DE;&#x503C;&#x3001;&#x53C2;&#x6570;&#x3001;&#x5F02;&#x5E38;&#x8BF4;&#x660E;&#x5916;&#xFF0C;&#x8FD8;&#x5FC5;&#x987B;&#x6307;&#x51FA;&#x8BE5;&#x65B9;&#x6CD5;&#x505A;&#x4EC0;&#x4E48;&#x4E8B;&#x60C5;&#xFF0C;&#x5B9E;&#x73B0;&#x4EC0;&#x4E48;&#x529F;&#x80FD;&#x3002; 
<br><span style="color:orange">&#x8BF4;&#x660E;</span>&#xFF1A;&#x5BF9;&#x5B50;&#x7C7B;&#x7684;&#x5B9E;&#x73B0;&#x8981;&#x6C42;&#xFF0C;&#x6216;&#x8005;&#x8C03;&#x7528;&#x6CE8;&#x610F;&#x4E8B;&#x9879;&#xFF0C;&#x8BF7;&#x4E00;&#x5E76;&#x8BF4;&#x660E;&#x3002; </li>
<li>&#x3010;&#x5F3A;&#x5236;&#x3011;&#x6240;&#x6709;&#x7684;&#x7C7B;&#x90FD;&#x5FC5;&#x987B;&#x6DFB;&#x52A0;&#x521B;&#x5EFA;&#x8005;&#x548C;&#x521B;&#x5EFA;&#x65E5;&#x671F;&#x3002; </li>
<li>&#x3010;&#x5F3A;&#x5236;&#x3011;&#x65B9;&#x6CD5;&#x5185;&#x90E8;&#x5355;&#x884C;&#x6CE8;&#x91CA;&#xFF0C;&#x5728;&#x88AB;&#x6CE8;&#x91CA;&#x8BED;&#x53E5;&#x4E0A;&#x65B9;&#x53E6;&#x8D77;&#x4E00;&#x884C;&#xFF0C;&#x4F7F;&#x7528;<code>//</code>&#x6CE8;&#x91CA;&#x3002;&#x65B9;&#x6CD5;&#x5185;&#x90E8;&#x591A;&#x884C;&#x6CE8;&#x91CA;&#x4F7F;&#x7528;<code>/* */</code>&#x6CE8;&#x91CA;&#xFF0C;&#x6CE8;&#x610F;&#x4E0E;&#x4EE3;&#x7801;&#x5BF9;&#x9F50;&#x3002; </li>
<li>&#x3010;&#x5F3A;&#x5236;&#x3011;&#x6240;&#x6709;&#x7684;&#x679A;&#x4E3E;&#x7C7B;&#x578B;&#x5B57;&#x6BB5;&#x5FC5;&#x987B;&#x8981;&#x6709;&#x6CE8;&#x91CA;&#xFF0C;&#x8BF4;&#x660E;&#x6BCF;&#x4E2A;&#x6570;&#x636E;&#x9879;&#x7684;&#x7528;&#x9014;&#x3002; </li>
<li>&#x3010;&#x63A8;&#x8350;&#x3011;&#x4E0E;&#x5176;&#x201C;&#x534A;&#x540A;&#x5B50;&#x201D;&#x82F1;&#x6587;&#x6765;&#x6CE8;&#x91CA;&#xFF0C;&#x4E0D;&#x5982;&#x7528;&#x4E2D;&#x6587;&#x6CE8;&#x91CA;&#x628A;&#x95EE;&#x9898;&#x8BF4;&#x6E05;&#x695A;&#x3002;&#x4E13;&#x6709;&#x540D;&#x8BCD;&#x4E0E;&#x5173;&#x952E;&#x5B57;&#x4FDD;&#x6301;&#x82F1;&#x6587;&#x539F;&#x6587;&#x5373;&#x53EF;&#x3002;
<br><span style="color:red">&#x53CD;&#x4F8B;</span>&#xFF1A;&#x201C;TCP&#x8FDE;&#x63A5;&#x8D85;&#x65F6;&#x201D;&#x89E3;&#x91CA;&#x6210;&#x201C;&#x4F20;&#x8F93;&#x63A7;&#x5236;&#x534F;&#x8BAE;&#x8FDE;&#x63A5;&#x8D85;&#x65F6;&#x201D;&#xFF0C;&#x7406;&#x89E3;&#x53CD;&#x800C;&#x8D39;&#x8111;&#x7B4B;&#x3002; </li>
<li>&#x3010;&#x63A8;&#x8350;&#x3011;&#x4EE3;&#x7801;&#x4FEE;&#x6539;&#x7684;&#x540C;&#x65F6;&#xFF0C;&#x6CE8;&#x91CA;&#x4E5F;&#x8981;&#x8FDB;&#x884C;&#x76F8;&#x5E94;&#x7684;&#x4FEE;&#x6539;&#xFF0C;&#x5C24;&#x5176;&#x662F;&#x53C2;&#x6570;&#x3001;&#x8FD4;&#x56DE;&#x503C;&#x3001;&#x5F02;&#x5E38;&#x3001;&#x6838;&#x5FC3;&#x903B;&#x8F91;&#x7B49;&#x7684;&#x4FEE;&#x6539;&#x3002; 
<br><span style="color:orange">&#x8BF4;&#x660E;</span>&#xFF1A;&#x4EE3;&#x7801;&#x4E0E;&#x6CE8;&#x91CA;&#x66F4;&#x65B0;&#x4E0D;&#x540C;&#x6B65;&#xFF0C;&#x5C31;&#x50CF;&#x8DEF;&#x7F51;&#x4E0E;&#x5BFC;&#x822A;&#x8F6F;&#x4EF6;&#x66F4;&#x65B0;&#x4E0D;&#x540C;&#x6B65;&#x4E00;&#x6837;&#xFF0C;&#x5982;&#x679C;&#x5BFC;&#x822A;&#x8F6F;&#x4EF6;&#x4E25;&#x91CD;&#x6EDE;&#x540E;&#xFF0C;&#x5C31;&#x5931;&#x53BB;&#x4E86;&#x5BFC;&#x822A;&#x7684;&#x610F;&#x4E49;&#x3002; </li>
<li>&#x3010;&#x53C2;&#x8003;&#x3011;&#x8C28;&#x614E;&#x6CE8;&#x91CA;&#x6389;&#x4EE3;&#x7801;&#x3002;&#x5728;&#x4E0A;&#x65B9;&#x8BE6;&#x7EC6;&#x8BF4;&#x660E;&lt;&#xFF0C;&#x800C;&#x4E0D;&#x662F;&#x7B80;&#x5355;&#x5730;&#x6CE8;&#x91CA;&#x6389;&#x3002;&#x5982;&#x679C;&#x65E0;&#x7528;&#xFF0C;&#x5219;&#x5220;&#x9664;&#x3002; 
<br><span style="color:orange">&#x8BF4;&#x660E;</span>&#xFF1A;&#x4EE3;&#x7801;&#x88AB;&#x6CE8;&#x91CA;&#x6389;&#x6709;&#x4E24;&#x79CD;&#x53EF;&#x80FD;&#x6027;&#xFF1A;
1&#xFF09;&#x540E;&#x7EED;&#x4F1A;&#x6062;&#x590D;&#x6B64;&#x6BB5;&#x4EE3;&#x7801;&#x903B;&#x8F91;&#x3002;
2&#xFF09;&#x6C38;&#x4E45;&#x4E0D;&#x7528;&#x3002;&#x524D;&#x8005;&#x5982;&#x679C;&#x6CA1;&#x6709;&#x5907;&#x6CE8;&#x4FE1;&#x606F;&#xFF0C;&#x96BE;&#x4EE5;&#x77E5;&#x6653;&#x6CE8;&#x91CA;&#x52A8;&#x673A;&#x3002;&#x540E;&#x8005;&#x5EFA;&#x8BAE;&#x76F4;&#x63A5;&#x5220;&#x6389;&#xFF08;&#x4EE3;&#x7801;&#x4ED3;&#x5E93;&#x4FDD;&#x5B58;&#x4E86;&#x5386;&#x53F2;&#x4EE3;&#x7801;&#xFF09;&#x3002; </li>
<li>&#x3010;&#x53C2;&#x8003;&#x3011;&#x5BF9;&#x4E8E;&#x6CE8;&#x91CA;&#x7684;&#x8981;&#x6C42;&#xFF1A;&#x7B2C;&#x4E00;&#x3001;&#x80FD;&#x591F;&#x51C6;&#x786E;&#x53CD;&#x5E94;&#x8BBE;&#x8BA1;&#x601D;&#x60F3;&#x548C;&#x4EE3;&#x7801;&#x903B;&#x8F91;&#xFF1B;&#x7B2C;&#x4E8C;&#x3001;&#x80FD;&#x591F;&#x63CF;&#x8FF0;&#x4E1A;&#x52A1;&#x542B;&#x4E49;&#xFF0C;&#x4F7F;&#x522B;&#x7684;&#x7A0B;&#x5E8F;&#x5458;&#x80FD;&#x591F;&#x8FC5;&#x901F;&#x4E86;&#x89E3;&#x5230;&#x4EE3;&#x7801;&#x80CC;&#x540E;&#x7684;&#x4FE1;&#x606F;&#x3002;&#x5B8C;&#x5168;&#x6CA1;&#x6709;&#x6CE8;&#x91CA;&#x7684;&#x5927;&#x6BB5;&#x4EE3;&#x7801;&#x5BF9;&#x4E8E;&#x9605;&#x8BFB;&#x8005;&#x5F62;&#x540C;
&#x5929;&#x4E66;&#xFF0C;&#x6CE8;&#x91CA;&#x662F;&#x7ED9;&#x81EA;&#x5DF1;&#x770B;&#x7684;&#xFF0C;&#x5373;&#x4F7F;&#x9694;&#x5F88;&#x957F;&#x65F6;&#x95F4;&#xFF0C;&#x4E5F;&#x80FD;&#x6E05;&#x6670;&#x7406;&#x89E3;&#x5F53;&#x65F6;&#x7684;&#x601D;&#x8DEF;&#xFF1B;&#x6CE8;&#x91CA;&#x4E5F;&#x662F;&#x7ED9;&#x7EE7;&#x4EFB;&#x8005;&#x770B;&#x7684;&#xFF0C;&#x4F7F;&#x5176;&#x80FD;&#x591F;&#x5FEB;&#x901F;&#x63A5;&#x66FF;&#x81EA;&#x5DF1;&#x7684;&#x5DE5;&#x4F5C;&#x3002; </li>
<li>&#x3010;&#x53C2;&#x8003;&#x3011;&#x597D;&#x7684;&#x547D;&#x540D;&#x3001;&#x4EE3;&#x7801;&#x7ED3;&#x6784;&#x662F;&#x81EA;&#x89E3;&#x91CA;&#x7684;&#xFF0C;&#x6CE8;&#x91CA;&#x529B;&#x6C42;&#x7CBE;&#x7B80;&#x51C6;&#x786E;&#x3001;&#x8868;&#x8FBE;&#x5230;&#x4F4D;&#x3002;&#x907F;&#x514D;&#x51FA;&#x73B0;&#x6CE8;&#x91CA;&#x7684;&#x4E00;&#x4E2A;&#x6781;&#x7AEF;&#xFF1A;&#x8FC7;&#x591A;&#x8FC7;&#x6EE5;&#x7684;&#x6CE8;&#x91CA;&#xFF0C;&#x4EE3;&#x7801;&#x7684;&#x903B;&#x8F91;&#x4E00;&#x65E6;&#x4FEE;&#x6539;&#xFF0C;&#x4FEE;&#x6539;&#x6CE8;&#x91CA;&#x662F;&#x76F8;&#x5F53;&#x5927;&#x7684;&#x8D1F;&#x62C5;&#x3002; 
<br><span style="color:red">&#x53CD;&#x4F8B;</span>&#xFF1A;<pre class="language-"><code>// put elephant into fridge  
put(elephant, fridge);      
&#x65B9;&#x6CD5;&#x540D;put&#xFF0C;&#x52A0;&#x4E0A;&#x4E24;&#x4E2A;&#x6709;&#x610F;&#x4E49;&#x7684;&#x53D8;&#x91CF;&#x540D;elephant&#x548C;fridge&#xFF0C;&#x5DF2;&#x7ECF;&#x8BF4;&#x660E;&#x4E86;&#x8FD9;&#x662F;&#x5728;&#x5E72;&#x4EC0;&#x4E48;&#xFF0C;&#x8BED;&#x4E49;&#x6E05;&#x6670;&#x7684;&#x4EE3;&#x7801;&#x4E0D;&#x9700;&#x8981;&#x989D;&#x5916;&#x7684;&#x6CE8;&#x91CA;&#x3002;
</code></pre></li>
<li>&#x3010;&#x53C2;&#x8003;&#x3011;&#x7279;&#x6B8A;&#x6CE8;&#x91CA;&#x6807;&#x8BB0;&#xFF0C;&#x8BF7;&#x6CE8;&#x660E;&#x6807;&#x8BB0;&#x4EBA;&#x4E0E;&#x6807;&#x8BB0;&#x65F6;&#x95F4;&#x3002;&#x6CE8;&#x610F;&#x53CA;&#x65F6;&#x5904;&#x7406;&#x8FD9;&#x4E9B;&#x6807;&#x8BB0;&#xFF0C;&#x901A;&#x8FC7;&#x6807;&#x8BB0;&#x626B;&#x63CF;&#xFF0C;&#x7ECF;&#x5E38;&#x6E05;&#x7406;&#x6B64;&#x7C7B;&#x6807;&#x8BB0;&#x3002;&#x7EBF;&#x4E0A;&#x6545;&#x969C;&#x6709;&#x65F6;&#x5019;&#x5C31;&#x662F;&#x6765;&#x6E90;&#x4E8E;&#x8FD9;&#x4E9B;&#x6807;&#x8BB0;&#x5904;&#x7684;&#x4EE3;&#x7801;&#x3002;<br>1&#xFF09; &#x5F85;&#x529E;&#x4E8B;&#x5B9C;&#xFF08;<strong>TODO</strong>&#xFF09;:&#xFF08; &#x6807;&#x8BB0;&#x4EBA;&#xFF0C;&#x6807;&#x8BB0;&#x65F6;&#x95F4;&#xFF0C;[&#x9884;&#x8BA1;&#x5904;&#x7406;&#x65F6;&#x95F4;]&#xFF09;    &#x8868;&#x793A;&#x9700;&#x8981;&#x5B9E;&#x73B0;&#xFF0C;&#x4F46;&#x76EE;&#x524D;&#x8FD8;&#x672A;&#x5B9E;&#x73B0;&#x7684;&#x529F;&#x80FD;&#x3002;&#x8FD9;&#x5B9E;&#x9645;&#x4E0A;&#x662F;&#x4E00;&#x4E2A;Javadoc&#x7684;&#x6807;&#x7B7E;&#xFF0C;&#x76EE;&#x524D;&#x7684;Javadoc&#x8FD8;&#x6CA1;&#x6709;&#x5B9E;&#x73B0;&#xFF0C;&#x4F46;&#x5DF2;&#x7ECF;&#x88AB;&#x5E7F;&#x6CDB;&#x4F7F;&#x7528;&#x3002;&#x53EA;&#x80FD;&#x5E94;&#x7528;&#x4E8E;&#x7C7B;&#xFF0C;&#x63A5;&#x53E3;&#x548C;&#x65B9;&#x6CD5;&#xFF08;&#x56E0;&#x4E3A;&#x5B83;&#x662F;&#x4E00;&#x4E2A;Javadoc&#x6807;&#x7B7E;&#xFF09;&#x3002;<br>2&#xFF09; &#x9519;&#x8BEF;&#xFF0C;&#x4E0D;&#x80FD;&#x5DE5;&#x4F5C;&#xFF08;<strong>FIXME</strong>&#xFF09;:&#xFF08;&#x6807;&#x8BB0;&#x4EBA;&#xFF0C;&#x6807;&#x8BB0;&#x65F6;&#x95F4;&#xFF0C;[&#x9884;&#x8BA1;&#x5904;&#x7406;&#x65F6;&#x95F4;]&#xFF09;    &#x5728;&#x6CE8;&#x91CA;&#x4E2D;&#x7528;FIXME&#x6807;&#x8BB0;&#x67D0;&#x4EE3;&#x7801;&#x662F;&#x9519;&#x8BEF;&#x7684;&#xFF0C;&#x800C;&#x4E14;&#x4E0D;&#x80FD;&#x5DE5;&#x4F5C;&#xFF0C;&#x9700;&#x8981;&#x53CA;&#x65F6;&#x7EA0;&#x6B63;&#x7684;&#x60C5;&#x51B5;&#x3002; </li>
</ol>

                                
                                </section>
                            
    </div>
    <div class="search-results">
        <div class="has-results">
            
            <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
            <ul class="search-results-list"></ul>
            
        </div>
        <div class="no-results">
            
            <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
            
        </div>
    </div>
</div>

                        </div>
                    </div>
                
            </div>

            
                
                <a href="控制语句.html" class="navigation navigation-prev navigation-unique" aria-label="Previous page: （七）控制语句">
                    <i class="fa fa-angle-left"></i>
                </a>
                
                
            
        
    </div>

    <script>
        var gitbook = gitbook || [];
        gitbook.push(function() {
            gitbook.page.hasChanged({"page":{"title":"（八）注释规约","level":"1.2.8","depth":2,"next":{"title":"二、异常日志","level":"1.3","depth":1,"ref":"","articles":[{"title":"（一）异常处理","level":"1.3.1","depth":2,"path":"异常日志/异常处理.md","ref":"异常日志/异常处理.md","articles":[]},{"title":"（二）日志规范","level":"1.3.2","depth":2,"path":"异常日志/日志规约.md","ref":"异常日志/日志规约.md","articles":[]},{"title":"（三）其他","level":"1.3.3","depth":2,"path":"异常日志/其他.md","ref":"异常日志/其他.md","articles":[]}]},"previous":{"title":"（七）控制语句","level":"1.2.7","depth":2,"path":"编程规约/控制语句.md","ref":"编程规约/控制语句.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["book-summary-scroll-position-saver","github","prism","-sharing","-highlight"],"pluginsConfig":{"github":{"url":"https://github.com/alibaba/p3c"},"book-summary-scroll-position-saver":{},"prism":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"website":"styles/website.css"}},"file":{"path":"编程规约/注释规约.md","mtime":"2022-05-11T03:50:37.000Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2022-11-12T09:10:13.396Z"},"basePath":"..","book":{"language":""}});
        });
    </script>
</div>

        
    <script src="../gitbook/gitbook.js"></script>
    <script src="../gitbook/theme.js"></script>
    
        
        <script src="../gitbook/gitbook-plugin-book-summary-scroll-position-saver/book-summary-scroll-position-saver.js"></script>
        
    
        
        <script src="../gitbook/gitbook-plugin-github/plugin.js"></script>
        
    
        
        <script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
        
    
        
        <script src="../gitbook/gitbook-plugin-search/search.js"></script>
        
    
        
        <script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
        
    
        
        <script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
        
    
        
        <script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
        
    

    </body>
</html>

